/*
 * Copyright (c) 2014, 2017, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.oracle.svm.core.genscavenge.graal;

import org.graalvm.compiler.core.common.type.StampFactory;
import org.graalvm.compiler.graph.NodeClass;
import org.graalvm.compiler.nodeinfo.InputType;
import org.graalvm.compiler.nodeinfo.NodeInfo;
import org.graalvm.compiler.nodes.FixedWithNextNode;
import org.graalvm.compiler.nodes.StructuredGraph;
import org.graalvm.compiler.nodes.memory.address.AddressNode;
import org.graalvm.compiler.nodes.spi.Lowerable;
import org.graalvm.compiler.nodes.spi.LoweringTool;

/** An abstract super-class for all the write barriers. */
@NodeInfo
public abstract class WriteBarrierNode extends FixedWithNextNode implements Lowerable {
    public static final NodeClass<WriteBarrierNode> TYPE = NodeClass.create(WriteBarrierNode.class);

    @Input(InputType.Association) protected AddressNode address;

    protected WriteBarrierNode(NodeClass<? extends WriteBarrierNode> c, AddressNode address) {
        super(c, StampFactory.forVoid());
        this.address = address;
    }

    public AddressNode getAddress() {
        return address;
    }

    @Override
    public void lower(LoweringTool tool) {
        // Check to make sure this is happening after FSA, so no nodes will get placed between
        // the WriteNode and the PostWriteBarrierNode.
        assert graph().getGuardsStage() == StructuredGraph.GuardsStage.AFTER_FSA;
        tool.getLowerer().lower(this, tool);
    }
}
